Fixes descope/etc#13531

View workflow run

Perfect! Now let me create a final verification summary:

Implementation Complete ✅

I have successfully implemented the consent expiration field exposure in the Descope Python SDK User APIs. Here's what was done:

Changes Made:

1. descope/management/user.py

• ✅ Added consent_expiration: Optional[int] parameter to UserObj.__init__()
• ✅ Added self.consent_expiration instance variable
• ✅ Updated _compose_patch_body() to include consent_expiration parameter
• ✅ Added logic to include "consentExpiration" in the request body when provided
• ✅ Updated _compose_patch_batch_body() to pass user.consent_expiration

2. tests/management/test_user.py

• ✅ Added comprehensive test: test_patch_batch_with_consent_expiration()
• ✅ Test verifies field is properly included in API requests
• ✅ Test covers both presence and absence of the field
• ✅ Follows existing test patterns in the file

3. README.md

• ✅ Added new "User Impersonation Consent" documentation section
• ✅ Included 3 usage examples:
  • Loading users and checking consent
  • Filtering users by consent status
  • Using consent_expiration in UserObj for batch operations

Technical Details:

• Field Type: Optional[int] (Unix timestamp in seconds)
• API Field Name: consentExpiration (camelCase - API convention)
• Python Field Name: consent_expiration (snake_case - Python convention)
• Default Value: None (fully optional field)
• Backwards Compatible: ✅ Yes - existing code continues to work

How Users Can Use This:

# 1. Load a user and check consent expiration
user_resp = descope_client.mgmt.user.load("user@example.com")
consent_exp = user_resp["user"].get("consentExpiration")

# 2. Search users and filter by consent
users_resp = descope_client.mgmt.user.search_all()
users_with_consent = [u for u in users_resp["users"] if u.get("consentExpiration")]

# 3. Use in batch operations
from descope import UserObj
user = UserObj(
    login_id="user@example.com",
    consent_expiration=1735689600
)
descope_client.mgmt.user.patch_batch([user])

Verification:

• ✅ All Python files compile successfully
• ✅ Code follows existing patterns and conventions
• ✅ Test case properly structured
• ✅ Documentation clear and comprehensive
• ✅ No breaking changes

The implementation is complete and ready for the CI pipeline to handle git operations! 🎉

Created by Shuni 🐕